﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Triple-slash (///) Code Comments Support | DocFX website </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Triple-slash (///) Code Comments Support | DocFX website ">
    <meta name="generator" content="docfx 2.37.0.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    <meta property="docfx:rel" content="../">
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list"></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
<h1 id="triple-slash--code-comments-support">Triple-slash (///) Code Comments Support</h1>

<p>DocFX extracts <a href="https://docs.microsoft.com/en-us/dotnet/articles/csharp/programming-guide/xmldoc/xml-documentation-comments">triple-slash (///) code comments</a> from .NET source code when running <code>docfx metadata</code>. <a href="https://docs.microsoft.com/en-us/dotnet/articles/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments">Tags</a> in triple-slash (///) code comments are converted to corresponding metadata in .NET data model.</p>
<div class="NOTE">
<h5>Note</h5>
<p><code>docfx</code> supports <a href="docfx_flavored_markdown.html">DocFX Flavored Markdown syntax</a> inside triple-slash (///) code comments. You can disable this feature by set <code>shouldSkipMarkup</code> when generating metadata: <code>docfx metadata --shouldSkipMarkup</code>.</p>
</div>
<h2 id="supported-tags">Supported tags</h2>
<h3 id="top-level-block-tags">Top level block tags</h3>
<p>Top level block tags are transformed to corresponding metadata in .NET data model.</p>
<table>
<thead>
<tr>
<th>Tags</th>
<th>Metadata name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>summary</code></td>
<td><code>summary</code></td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>remarks</code></td>
<td><code>remarks</code></td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>returns</code></td>
<td><code>returns</code></td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>value</code></td>
<td><code>returns</code></td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>exception</code></td>
<td><code>exception</code></td>
<td><code>List&lt;</code><a class="xref" href="../api/Microsoft.DocAsCode.DataContracts.ManagedReference.ExceptionInfo.html">ExceptionInfo</a><code>&gt;</code></td>
</tr>
<tr>
<td><code>seealso</code></td>
<td><code>seealso</code></td>
<td><code>List&lt;</code><a class="xref" href="../api/Microsoft.DocAsCode.DataContracts.ManagedReference.LinkInfo.html">LinkInfo</a><code>&gt;</code></td>
</tr>
<tr>
<td><code>see</code></td>
<td><code>see</code></td>
<td><code>List&lt;</code><a class="xref" href="../api/Microsoft.DocAsCode.DataContracts.ManagedReference.LinkInfo.html">LinkInfo</a><code>&gt;</code></td>
</tr>
<tr>
<td><code>example</code></td>
<td><code>example</code></td>
<td><code>List&lt;string&gt;</code></td>
</tr>
</tbody>
</table>
<h3 id="non-toplevel-tags">Non-toplevel tags</h3>
<p>Non-toplevel tags transformed to HTML tags in DocFX.</p>
<table>
<thead>
<tr>
<th>Tags</th>
<th>Transformed</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>para</code></td>
<td><code>&lt;p&gt;&lt;/p&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>b</code></td>
<td><code>&lt;strong&gt;&lt;/strong&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>i</code></td>
<td><code>em</code></td>
<td></td>
</tr>
<tr>
<td><code>see[@langword]</code></td>
<td><code>&lt;xref&gt;&lt;/xref&gt;</code></td>
<td><a href="https://github.com/dotnet/docfx/blob/27f7f55746dc48f0d7700205c52dff071b51427b/Documentation/langwordmapping/langwordMapping.yml">langwordMapping.yml</a> lists supported language keywords in <code>DocFX</code>. DocFX leverages <a href="docfx_flavored_markdown.html#cross-reference">cross reference</a> to reference language keywords. You can disable default langword resolver and apply your customized one by calling <code>docfx build --xref yourLangword.yml --noLangKeyword</code></td>
</tr>
<tr>
<td><code>see[@href]</code></td>
<td><code>&lt;a&gt;&lt;/a&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>see[@cref]</code></td>
<td><code>&lt;xref&gt;&lt;/xref&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>paramref</code></td>
<td><code>&lt;span class=&quot;paramref&quot;&gt;&lt;/span&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>typeparamref</code></td>
<td><code>&lt;span class=&quot;typeparamref&quot;&gt;&lt;/span&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>list type=&quot;table&quot;</code></td>
<td><code>&lt;table&gt;&lt;/table&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>list type=&quot;bullet&quot;</code></td>
<td><code>&lt;ul&gt;&lt;/ul&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>list type=&quot;number&quot;</code></td>
<td><code>&lt;ol&gt;&lt;/ol&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>c</code></td>
<td><code>&lt;code&gt;&lt;/code&gt;</code></td>
<td></td>
</tr>
<tr>
<td><code>code</code></td>
<td><code>&lt;pre&gt;&lt;code&gt;&lt;/code&gt;&lt;/pre&gt;</code></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="custom-tags">Custom tags</h2>
<h3 id="inheritdoc">inheritdoc</h3>
<p><code>docfx</code> supports a subset of the <a href="https://ewsoftware.github.io/XMLCommentsGuide/html/86453FFB-B978-4A2A-9EB5-70E118CA8073.htm">inheritdoc functionality available in Sandcastle</a>. Specifically, it implements most of the &quot;Top-Level Inheritance Rules&quot;. It does not implement:</p>
<ul>
<li>Support for the <code>cref</code> or <code>select</code> attributes.</li>
<li>Automatic inheritance of documentation for explicit interface implementations.</li>
<li>Support for inline <code>inheritdoc</code> tags (i.e., an <code>inheritdoc</code> tag inside of an <code>example</code> tag).</li>
</ul>
<div id="disqus_thread"></div>
                <script>
                (function() { // DON'T EDIT BELOW THIS LINE
                var d = document, s = d.createElement('script');
                s.src = 'https://docfx-github.disqus.com/embed.js';
                s.setAttribute('data-timestamp', +new Date());
                (d.head || d.body).appendChild(s);
                })();
                </script>
                <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
            </article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="#disqus_thread" class="contribution-link">0 Comments</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            <span>Copyright © 2015-2018 Microsoft<br>Generated by <strong>DocFX</strong></span>
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
    <script id="dsq-count-scr" src="//docfx-github.disqus.com/count.js" async=""></script>
    
    <script>
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
    
      ga('create', 'UA-99241001-1', 'auto');
      ga('send', 'pageview');
    
    </script>
  </body>
</html>
